Skip to content

Conversation

kahirokunn
Copy link
Member

The original ClusterProperty documentation was hard to follow and left some key
questions unanswered, such as where the custom resource should be placed, how it
actually ties to a cluster, and what is explicitly defined versus left
unspecified.

For me, this meant that even though I understood ClusterProperty could identify
a cluster, I struggled to grasp its lifecycle and practical usage without
digging into the KEP directly.

This PR expands the documentation with lifecycle rules, constraints, use cases,
and operational guidance, so readers can build an intuitive understanding of
ClusterProperty without having to cross-reference the KEP.

I hope this helps others who may run into the same confusion and need a more
practical, approachable explanation.

Unlike the exhaustive and formal style of the KEP, this documentation focuses
on clarity and practical understanding, so that readers can quickly grasp what
ClusterProperty is and how to use it.

Copy link

netlify bot commented Sep 2, 2025

Deploy Preview for kubernetes-sig-multicluster ready!

Name Link
🔨 Latest commit f2a0ae2
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-sig-multicluster/deploys/68b6725fd0e76f0008468f91
😎 Deploy Preview https://deploy-preview-42--kubernetes-sig-multicluster.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: kahirokunn
Once this PR has been reviewed and has the lgtm label, please assign jeremyot for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 2, 2025
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 2, 2025
@kahirokunn kahirokunn force-pushed the improve-about-api-docs branch from 3855ba7 to 2e20003 Compare September 2, 2025 04:27
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 2, 2025
@kahirokunn kahirokunn force-pushed the improve-about-api-docs branch from 2e20003 to f2a0ae2 Compare September 2, 2025 04:28
@kahirokunn kahirokunn changed the title Make ClusterProperty easier to understand with clearer usage and lifecycle context fix: make ClusterProperty easier to understand with clearer usage and lifecycle context Sep 2, 2025
@lauralorenz
Copy link
Contributor

/sig multicluster

@k8s-ci-robot k8s-ci-robot added the sig/multicluster Categorizes an issue or PR as relevant to SIG Multicluster. label Sep 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. sig/multicluster Categorizes an issue or PR as relevant to SIG Multicluster. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants